/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.hibernate.qtags;

/**
 * Declare a sql query for class. Queries are taken from defining class only.
 * no inheritance here due to uniqueness of names
 *
 * @author Anatol Pomozov
 * @qtags.location class
 */
public interface HibernateSqlQueryTag extends com.thoughtworks.qdox.model.DocletTag {
    /**
     * Query Attribute
     *
     */
    String getCacheRegion();

    /**
     * Query Attribute
     */
    Boolean getCacheable();

    /**
     * Name of this query
     *
     * @qtags.required
     */
    String getName_();

    /**
     * Query contents
     *
     */
    String getQuery();

    /**
     * Query Parameter Return-Scalar-Column
     *
     */
    String getReturnScalarColumn();

    /**
     * Query Parameter Return-Scalar-Type
     *
     */
    String getReturnScalarType();
    
    /**
     * callability
     */
    Boolean getCallable();
}